Skip to content

docs: Adds more details,titles and examples to readme file#33

Open
Siddhant-Srivastava-20 wants to merge 1 commit intoaces:mainfrom
Siddhant-Srivastava-20:doc_issue
Open

docs: Adds more details,titles and examples to readme file#33
Siddhant-Srivastava-20 wants to merge 1 commit intoaces:mainfrom
Siddhant-Srivastava-20:doc_issue

Conversation

@Siddhant-Srivastava-20
Copy link
Copy Markdown

Added Documentation:
1.Title of "GSOC Project 2025"
2.Briefly mentioned what is CBRAIN
3.Added command Examples

Signed-off-by: SIDDHANT SRIVASTAVA <siddhantsrivastava@SIDDHANTs-MacBook-Pro.local>
Comment thread README.md
2. **Custom/Development Setup**
- Deploy CBRAIN on your lab cluster, cloud, or virtual machine
- Suitable for organizations that require their own CBRAIN instance or which prefer to host CBRAIN themselves due to legal or corporate requirements
- Suitable for organizations that require their own CBRAIN instance or which prefer to host CBRAIN themselves due to legal or corporate requirements.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure why full stop only here and not in other enumerations. Should be uniform

@MontrealSergiy
Copy link
Copy Markdown
Contributor

MontrealSergiy commented Jan 12, 2026

I think examples of
--json
--jsonl

are needed

(ideally with output), as not everybody understand what is jsonl

@MontrealSergiy
Copy link
Copy Markdown
Contributor

not sure, while there is some improvement, the improvement is minor. Any opinions @dlq @prioux @natacha-beck

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants